Skip to content

release: config-first sources, doc cleanup, audio skill, dist gitignore#49

Merged
jb-thery merged 6 commits into
mainfrom
develop
Jul 3, 2026
Merged

release: config-first sources, doc cleanup, audio skill, dist gitignore#49
jb-thery merged 6 commits into
mainfrom
develop

Conversation

@jb-thery

@jb-thery jb-thery commented Jul 3, 2026

Copy link
Copy Markdown
Member

Release PR — develop → main

Promotes the sources config-first fix, dead-doc cleanup, audio-summary skill rewrite, and dist-as-gitignored-output change to production. Merging this PR triggers the protected Release npm workflow (semantic-release derives the version from Conventional Commits and publishes @jcode.labs/ragmir-tts then @jcode.labs/ragmir).

Expected version bump

MINOR (feat(audio-summary) + fix(sources) + fix(core) build order). No breaking public-API changes.

What's in this release

  • feat(audio-summary): intent-driven memorable narration skill (8-step spine + listening-style.md + narration-templates.md).
  • fix(sources): ragmir sources add/list write to the sources array in .ragmir/config.json instead of the legacy sources.txt (read-only retrocompat).
  • fix(core): ragmir-core check/test now build ragmir-tts first (required since dist became gitignored).
  • chore: untrack dist/ build output from the git index.
  • docs: remove dead kb references (SECURITY-HARDENING, SECURITY, CHANGELOG), sync sources.txt guidance with the new config-first behavior, add a Mermaid diagram.

After merge

The Release npm workflow publishes both packages. No local publish, no direct push to main.

jb-thery added 6 commits July 4, 2026 03:09
…tion

Replace the generic narration guidance with a deliberate, technique-based
pipeline that produces spoken summaries a listener can follow and retain,
instead of basic summaries read aloud.

The TTS rendering pipeline is untouched; all changes target the narration
script quality upstream.

SKILL.md is restructured into an 8-step spine (capture intent, verify KB,
search, choose format, write for listening, anchor memorability, render,
report). Two reference files are added next to SKILL.md and bundled
automatically: listening-style.md (pacing, TTS punctuation, anti-patterns)
and narration-templates.md (skeletons per format, signposting and
active-recall catalogues).
The previous chore added packages/*/dist/ to .gitignore but did not run
git rm --cached, so 128 dist files (ragmir-core + ragmir-tts) inherited
from the rebrand commit stayed tracked. .gitignore does not untrack
already-tracked files retroactively.

Untrack them now so the index matches the gitignore policy. The files stay
on disk (rebuilt locally with pnpm build) and are no longer version
controlled, consistent with the dist-as-build-output decision.
ragmir sources add/list now read and write the sources array of
.ragmir/config.json instead of the legacy .ragmir/sources.txt file. This
matches the config-first direction: ragmir init already stopped creating
sources.txt, but sources add still wrote to it, leaving projects with an
empty config sources array and all entries stranded in the legacy file.

- addSourceEntries writes into config.json sources, preserving other fields.
- listSourceEntries reads from config.json and merges a legacy sources.txt
  read-only when present, so existing projects keep working.
- Never create or write sources.txt anymore.
- Remove the now-unused SOURCES_FILE_HEADER from defaults.ts.
Clean up documentation that still presented the legacy kb binary and .kb/
paths as current, and sync the sources guidance with the new config-first
behavior.

- SECURITY-HARDENING.md: .kb/ to .ragmir/, kb destroy-index to ragmir
  destroy-index, .kb/config.json to .ragmir/config.json.
- SECURITY.md: data boundary now favors .ragmir/, keeps .kb/ as legacy.
- CHANGELOG.md: rewrite historical kb command names to ragmir with a legacy
  note; KB_INCLUDE_EXTENSIONS to RAGMIR_INCLUDE_EXTENSIONS.
- README.md: sources.txt legacy note now matches sources.ts. Add a Mermaid
  diagram for the rawDir plus sources plus legacy merge flow.
- AGENTS.md and docs/cli-reference.md: sources add/list target config.json.
dist/ is now gitignored build output, so ragmir-core can no longer rely on
a committed ragmir-tts/dist to resolve the @jcode.labs/ragmir-tts import
during typecheck and tests. In CI the check step runs before build, so the
tts dist does not exist yet and tsc --noEmit fails with 'Cannot find module'.

Make the core check and test scripts build ragmir-tts first, so the tts
dist exists before core resolves it. This mirrors how pnpm build already
orders tts before core.
…tion

fix(sources): config-first sources, doc cleanup, audio skill
@jb-thery jb-thery merged commit 2439832 into main Jul 3, 2026
10 checks passed
@jb-thery jb-thery self-assigned this Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

🎉 This PR is included in version 2.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant